home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmQTscrollFrame.z / XmQTscrollFrame
Text File  |  1998-10-30  |  13KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           _X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e - A widget holding this trait can handle one
  10.           or more navigator widgets
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/ScrollFrameT.h>
  14.  
  15.           typdefe struct {
  16.                     int                               version;
  17.                     XmScrollFrameInitProc             init;
  18.                     XmScrollFrameGetInfoProc          getInfo;
  19.                     XmScrollFrameAddNavigatorProc     addNavigator;
  20.                     XmScrollFrameRemoveNavigatorProc  removeNavigator;
  21.           } XmSrollFrameTraitRec, *XmScrollFrameTrait;
  22.           vvvvooooiiiidddd ((((****XXXXmmmmSSSSccccrrrroooollllllllFFFFrrrraaaammmmeeeeIIIInnnniiiittttPPPPrrrroooocccc))))(
  23.           WWWWiiiiddddggggeeeetttt,
  24.           XXXXttttCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc,
  25.           WWWWiiiiddddggggeeeetttt,
  26.           BBBBoooooooolllleeeeaaaannnn ((((****XXXXmmmmSSSSccccrrrroooollllllllFFFFrrrraaaammmmeeeeGGGGeeeettttIIIInnnnffffooooPPPPrrrroooocccc))))(
  27.           WWWWiiiiddddggggeeeetttt,
  28.           CCCCaaaarrrrddddiiiinnnnaaaallll****,
  29.           WWWWiiiiddddggggeeeetttt********,
  30.           CCCCaaaarrrrddddiiiinnnnaaaallll****,
  31.           vvvvooooiiiidddd ((((****XXXXmmmmSSSSccccrrrroooollllllllFFFFrrrraaaammmmeeeeAAAAddddddddNNNNaaaavvvviiiiggggaaaattttoooorrrrPPPPrrrroooocccc))))(
  32.           WWWWiiiiddddggggeeeetttt,
  33.           WWWWiiiiddddggggeeeetttt,
  34.           MMMMaaaasssskkkk,
  35.           vvvvooooiiiidddd ((((****XXXXmmmmSSSSccccrrrroooollllllllFFFFrrrraaaammmmeeeeRRRReeeemmmmoooovvvveeeeNNNNaaaavvvviiiiggggaaaattttoooorrrrPPPPrrrroooocccc))))(
  36.           WWWWiiiiddddggggeeeetttt,
  37.           WWWWiiiiddddggggeeeetttt);
  38.  
  39.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  40.           This page documents Motif 2.1.
  41.  
  42.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  43.           A widget holding the _X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e trait can handle one or
  44.           more navigator widgets and use them to pan a scrollable
  45.           object.  The trait methods of _X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e are useful if
  46.           you are writing you own navigator or scrollable widget.
  47.  
  48.           The following standard Motif manager widgets hold this
  49.           trait:
  50.  
  51.              +o  XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww
  52.  
  53.              +o  XXXXmmmmNNNNooootttteeeebbbbooooooookkkk
  54.  
  55.           In addition, the following standard Motif widgets access the
  56.           trait methods of _X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e:
  57.  
  58.              +o  XXXXmmmmLLLLiiiisssstttt
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.              +o  XXXXmmmmTTTTeeeexxxxtttt
  75.  
  76.         TTTThhhheeee iiiinnnniiiitttt TTTTrrrraaaaiiiitttt MMMMeeeetttthhhhoooodddd
  77.           vvvvooooiiiidddd iiiinnnniiiitttt(
  78.           WWWWiiiiddddggggeeeetttt ssssccccrrrroooollllllllFFFFrrrraaaammmmeeeeWWWWiiiiddddggggeeeetttt,
  79.           XXXXttttCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc mmmmoooovvvveeeeCCCCBBBB,
  80.           WWWWiiiiddddggggeeeetttt ssssccccrrrroooollllllllaaaabbbblllleeeeWWWWiiiiddddggggeeeetttt);
  81.  
  82.           The iiiinnnniiiitttt trait method initializes several internal data
  83.           fields.  One of these fields must hold the name the default
  84.           move callback (_m_o_v_e_C_B) procedure that is to be associated
  85.           with this widget.
  86.  
  87.           _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t
  88.                     Specifies the widget that holds the
  89.                     _X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e trait.
  90.  
  91.           _m_o_v_e_C_B    Specifies the default move callback procedure that
  92.                     is to be associated with this widget. Typically,
  93.                     this callback is going to be added to a list of
  94.                     navigator widgets maintained by the
  95.                     _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t.
  96.  
  97.           _s_c_r_o_l_l_a_b_l_e_W_i_d_g_e_t
  98.                     Specifies client data to be passed to the _m_o_v_e_C_B.
  99.                     Typically, the client data will be the name of a
  100.                     scrollable widget.
  101.  
  102.         TTTThhhheeee ggggeeeettttIIIInnnnffffoooo TTTTrrrraaaaiiiitttt MMMMeeeetttthhhhoooodddd
  103.           BBBBoooooooolllleeeeaaaannnn ggggeeeettttIIIInnnnffffoooo(
  104.           WWWWiiiiddddggggeeeetttt ssssccccrrrroooollllllllFFFFrrrraaaammmmeeeeWWWWiiiiddddggggeeeetttt,
  105.           CCCCaaaarrrrddddiiiinnnnaaaallll ****ddddiiiimmmmeeeennnnssssiiiioooonnnn,
  106.           WWWWiiiiddddggggeeeetttt ********nnnnaaaavvvv____lllliiiisssstttt,
  107.           CCCCaaaarrrrddddiiiinnnnaaaallll ****nnnnuuuummmm____nnnnaaaavvvv____lllliiiisssstttt);
  108.  
  109.           The ggggeeeettttIIIInnnnffffoooo trait method returns information about the
  110.           _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t. The caller may set the _d_i_m_e_n_s_i_o_n,
  111.           _n_a_v__l_i_s_t, or _n_u_m__n_a_v__l_i_s_t fields to _N_U_L_L if the returned
  112.           information would be of no interest.
  113.  
  114.           _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t
  115.                     Specifies the widget that is providing this
  116.                     method.
  117.  
  118.           _d_i_m_e_n_s_i_o_n Returns the dimension(s) that _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_tis
  119.                     capable of operating upon.
  120.  
  121.           _n_a_v__l_i_s_t  Returns the current list of navigators associated
  122.                     with this _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t.  This data is
  123.                     returned to internal storage, and should not be
  124.                     modified or freed by the caller.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           _n_u_m__n_a_v__l_i_s_t
  141.                     Returns the number of navigators returned in
  142.                     _n_a_v__l_i_s_t.
  143.  
  144.           This method returns _T_r_u_e if the iiiinnnniiiitttt trait method was
  145.           already called. This method returns _F_a_l_s_e if iiiinnnniiiitttthas not yet
  146.           been called. If this method returns _F_a_l_s_e, then the returned
  147.           information in the other fields should be ignored.
  148.  
  149.         TTTThhhheeee aaaaddddddddNNNNaaaavvvviiiiggggaaaattttoooorrrr TTTTrrrraaaaiiiitttt MMMMeeeetttthhhhoooodddd
  150.           vvvvooooiiiidddd aaaaddddddddNNNNaaaavvvviiiiggggaaaattttoooorrrr(
  151.           WWWWiiiiddddggggeeeetttt ssssccccrrrroooollllllllFFFFrrrraaaammmmeeeeWWWWiiiiddddggggeeeetttt,
  152.           WWWWiiiiddddggggeeeetttt nnnnaaaavvvviiiiggggaaaattttoooorrrrWWWWiiiiddddggggeeeetttt,
  153.           MMMMaaaasssskkkk ddddiiiimmmmMMMMaaaasssskkkk);
  154.  
  155.           The aaaaddddddddNNNNaaaavvvviiiiggggaaaattttoooorrrr trait method associates a
  156.           _n_a_v_i_g_a_t_o_r_W_i_d_g_e_twith a _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t. Since one
  157.           _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t can support multiple navigator widgets, it
  158.           is possible that this method will be called multiple times.
  159.  
  160.           _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t
  161.                     Specifies the scroll frame widget that is
  162.                     providing this method.
  163.  
  164.           _n_a_v_i_g_a_t_o_r_W_i_d_g_e_t
  165.                     Specifies the navigator widget to be associated
  166.                     with the _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t.
  167.  
  168.           _d_i_m_M_a_s_k   Specifies the dimension(s) upon which the
  169.                     _n_a_v_i_g_a_t_o_r_W_i_d_g_e_tis going to operate.
  170.  
  171.         TTTThhhheeee rrrreeeemmmmoooovvvveeeeNNNNaaaavvvviiiiggggaaaattttoooorrrr TTTTrrrraaaaiiiitttt MMMMeeeetttthhhhoooodddd
  172.           vvvvooooiiiidddd rrrreeeemmmmoooovvvveeeeNNNNaaaavvvviiiiggggaaaattttoooorrrr(
  173.           WWWWiiiiddddggggeeeetttt ssssccccrrrroooollllllllFFFFrrrraaaammmmeeeeWWWWiiiiddddggggeeeetttt,
  174.           WWWWiiiiddddggggeeeetttt nnnnaaaavvvviiiiggggaaaattttoooorrrrWWWWiiiiddddggggeeeetttt);
  175.  
  176.           The rrrreeeemmmmoooovvvveeeeNNNNaaaavvvviiiiggggaaaattttoooorrrr trait method disassociates a
  177.           _n_a_v_i_g_a_t_o_r_W_i_d_g_e_tfrom a _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t. Since one
  178.           _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t can support multiple _n_a_v_i_g_a_t_o_r_W_i_d_g_e_ts,
  179.           this method can be called multiple times.
  180.  
  181.           It is the responsibility of whomever associated the
  182.           _n_a_v_i_g_a_t_o_r_W_i_d_g_e_twith the _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t to call
  183.           rrrreeeemmmmoooovvvveeeeNNNNaaaavvvviiiiggggaaaattttoooorrrr prior to destroying it.
  184.  
  185.           _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t
  186.                     Specifies the scroll frame widget that is
  187.                     providing this method.
  188.  
  189.           _n_a_v_i_g_a_t_o_r_W_i_d_g_e_t
  190.                     Specifies the navigator widget to be disassociated
  191.                     from the _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t.
  192.  
  193.  
  194.  
  195.      Page 3                                         (printed 10/24/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))
  203.  
  204.  
  205.  
  206.      RRRREEEELLLLAAAATTTTEEEEDDDD
  207.           XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww(3), XXXXmmmmNNNNooootttteeeebbbbooooooookkkk(3), and XXXXmmmmQQQQTTTTnnnnaaaavvvviiiiggggaaaattttoooorrrr(3).
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                         (printed 10/24/98)
  262.  
  263.  
  264.  
  265.